home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / tbbs / msgx10.zip / MSGX.DOC next >
Text File  |  1996-01-24  |  4KB  |  76 lines
  1. Message Extraction Option Module (MSGX) Version 1.0
  2. Requires TBBS 2.3 or higher in order to run
  3.  
  4. The MSGX Option Module is designed to help third party developers create
  5. programs that can access information from the TBBS message base.  Currently
  6. TDBS programs cannot access the message base in any way that is meaningful. 
  7. MSGX allows real-time message base extraction of messages addressed to specific
  8. users.  This allows third party developers to create messages on one machine
  9. (via the TBBS type=7 with Opt Data=/C:file) that can get sent to another
  10. machine for processing.  This powerful feature allows multi-system gaming,
  11. shared databases, etc., but it is not limited to just that kind of
  12. functionality.  It is limited only by the creativity of the programmer.
  13.  
  14. MSGX has very little in the way of configuration.  The configuration file is
  15. called MSGX.CTL, it can be anywhere in the TBBSPATH, and it consists of lines
  16. that are either configuration lines, or commentary lines (begin with anything
  17. except a quote character).  Configuration lines are all of the form:
  18.  
  19. "<username>" <directory> <extension (no dot)> [flags]
  20.  
  21. [flags] is optional, and as currently designed, only one flag exists.  The D
  22. flag tells MSGX to mark any messages extracted  as "deleted" within the TBBS
  23. message base.
  24.  
  25. For example:
  26.  
  27. "PROGRAM1 GHOST"     C:\TBBS\PROGRAM1\DATA     PG1
  28. "POKER"            C:\TBBS\POKER\DATA    POK    D
  29. "SILLY GAME"        C:\TBBS\SILLYG\INBOUND    SG1
  30.  
  31. To install MSGX in your TBBS system, you will need to edit your MLTBBS command
  32. line in your RUNBBS.BAT file.  If you are currently not running any option
  33. modules, you will need to add /O:MSGX to the end of the MLTBBS command line. 
  34. If you are already running option modules (ie, the /O: is already present and
  35. followed by other program names), then you will need to add MSGX to the option
  36. module list.  To do this, add a comma and the name MSGX to the /O: string. 
  37. For example, if you currently have:
  38.  
  39.   /O:TIMS,SYSOM
  40.  
  41. change it to:
  42.  
  43.   /O:TIMS,SYSOM,MSGX
  44.  
  45. MSGX is an option module type=209 and needs to be started via CEDIT ghost
  46. events as a type=209 on all days on line 254, with Opt Data being a number
  47. corresponding to how many seconds MSGX should delay between checks for new
  48. messages (default is to just run once if no time period is given).  It can also
  49. be started directly as a type=209 with Opt Data=<filename> for a file to use
  50. as a configuration file to extract messages for one time.  If a TDBS program
  51. wishes to update the MSGX.CTL file while the system is running, it can do so
  52. (the file is normally only read at TBBS startup).  To tell MSGX to re-read the
  53. file, a file named MSGX.FLG must be placed in the current TBBS directory. When
  54. MSGX goes to do its normal scan if this file is found, it is deleted and the
  55. current MSGX.CTL file is read from disk and used as the new MSGX
  56. configuration.
  57.  
  58. MSGX will honor external events and exit properly.  While it is running, every
  59. X seconds (from the Opt Data line) MSGX will check each user in the
  60. configuration file to see if there are any new messages waiting for that 
  61. user.  If there are, the message will be extracted from the message base in the
  62. format given below and placed in the defined directory with the defined
  63. extension.  The base name of the file will be a random string, so only the 
  64. extension can be used to locate the proper files for each user.  The files are
  65. extracted in the following format:
  66.  
  67. #: <message number>                #: 32105
  68. F: <from (including @node number if Fidonet)>    F: SILLY GAME@1:104/23
  69. T: <to>                        T: SILLY GAME
  70. S: <subject>                    S: UPDATE RECORDS
  71. D: <date>                    D: 01/11/96 01:12:10
  72. E: <enclosure name>,<name on disk>        E: UPDATE.DBF,C:\ENCL\EM32105
  73. <blank line to separate header from text>
  74. <message body text>                Update these records
  75.  
  76.